home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilMergeImg.z / ilMergeImg
Encoding:
Text File  |  2002-10-03  |  10.9 KB  |  199 lines
  1.  
  2.  
  3.  
  4. iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg - merge several images into one
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage : ilCacheImg : ilMemCacheImg : ilOpImg
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilMergeImg.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      This class is publicly derived from ilOpImg. This class makes it possible
  19.      to merge a number of images, all of the same size, into one. This merged
  20.      image can now be treated as an independent ilImage. One can also assign a
  21.      data type and order to this merged image that may be different from the
  22.      parent images. The number of channels in the merged image is equal to the
  23.      sum of the number of channels of the parent images. One can imagine the
  24.      images to be stacked up one behind the other in the order in which they
  25.      are specified.
  26.  
  27.      Among the important public member functions are three different
  28.      constructors.  They differ in the way the order and type of the merged
  29.      image is specified.
  30.  
  31.      The reset function inherited from ilLink is redefined so that ilMergeImg
  32.      attributes that have not been explicitly set, are set to those of the
  33.      first parent image during the reset operation.
  34.  
  35. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  36.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
  37.  
  38.           ilMergeImg(IlImage** imgPtr, int nimg, iflOrder order=ilInterleaved,
  39.                      iflDataType dtype=iflDataType(0))
  40.           ilMergeImg(int nimg, ilImage** imgPtr)
  41.           ilMergeImg(ilImage* img0=NULL, ilImage* img1=NULL, ilImage* img2=NULL,
  42.                   iflOrder order=ilInterleaved, iflDataType dtype=iflDataType(0));
  43.  
  44.  
  45. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  46.      iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg(((())))
  47.  
  48.           ilMergeImg(IlImage** imgPtr, int nimg, iflOrder order=ilInterleaved,
  49.                      iflDataType dtype=iflDataType(0))
  50.           ilMergeImg(int nimg, ilImage** imgPtr)
  51.           ilMergeImg(ilImage* img0=NULL, ilImage* img1=NULL, ilImage* img2=NULL,
  52.                   iflOrder order=ilInterleaved, iflDataType dtype=iflDataType(0));
  53.  
  54.  
  55.           In the first two constructors listed above, _i_m_g_P_t_r is an array of
  56.           pointers to the input ilImages.  The number of images to be merged
  57.           is specified by _n_i_m_g. The first _n_i_m_g ilImages in the list are
  58.           merged, any others are ignored.  Therefore, _i_m_g_P_t_r should have at
  59.           least _n_i_m_g pointers.  The final constructor allows up to three
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74.           images, _i_m_g_0, _i_m_g_1 and _i_m_g_2, to be specified without requiring an
  75.           array of images to be constructed. Any or all of these images
  76.           pointers may be NULL.
  77.  
  78.           The first and last constructors allow you to specify an order and
  79.           type for the merged image.  If the default data type, 0, is used,
  80.           the data type of the merged image is taken to be the data type with
  81.           the most precision of the input images.  In the second constructor,
  82.           the order and data type of the merged image is taken to be the first
  83.           ilImage pointed to by _i_m_g_P_t_r.
  84.  
  85. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  86.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllOOOOppppIIIImmmmgggg
  87.      checkMinMax(), clearClamp(), getBias(), getClamp(), getInputMax(),
  88.      getInputMin(), getInputScaleMax(), getInputScaleMin(), getValidOrders(),
  89.      getValidTypes(), isClamped(), isDiff(), isPrecisionKept(),
  90.      keepPrecision(), resetOp(), setBias(), setClamp(), setMaxPageSize(),
  91.      setMinPageSize(), setValidOrder(), setValidType(), setWorkingType()
  92.  
  93.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg
  94.      allocPage(), doUserPageAlloc(), enableMP(), executeRequest(),
  95.      finishRequest(), freePage(), getGlobalThrashMode(), getMpRequest(),
  96.      getPage(), getPageAllocTime(), getPageTime(), getRetainMode(),
  97.      getRetainPath(), getThrashMode(), getThrashTime(), getTotalPageTime(),
  98.      isMPenabled(), isUserPageAlloc(), prepareRequest(),
  99.      setGlobalThrashMode(), setPage(), setPageAllocTime(), setRetainMode(),
  100.      setRetainPath(), setThrashMode(),
  101.  
  102.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg
  103.      enablePagingCallback(), flush(), getCacheSize(),
  104.      isPagingCallbackEnabled(), listResident()
  105.  
  106.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  107.      addInput(), allocFillData(), checkColorModel(), checkValidOrder(),
  108.      checkValidType(), clipTile(), configureRetainedCache(), copy(),
  109.      copyTile(), copyTile3D(), copyTileCfg(), fillTile(), fillTile3D(),
  110.      fillTileRGB(), freeFillData(), getColorImg(), getColorModel(),
  111.      getColormap(), getCompression(), getConfig(), getCopyConverter(),
  112.      getCsize(), getDataType(), getDimensions(), getDirectInput(),
  113.      getDisplayCacheEnable(), getFill(), getFillData(), getFillValue(),
  114.      getHeight(), getHwEnable(), getHwHint(), getHwIntHint(), getHwOp(),
  115.      getHwPassTable(), getInput(), getInputTileRequirement(),
  116.      getLockTileSet(), getMaxColormapLevels(), getMaxValue(), getMinValue(),
  117.      getNumChans(), getNumInputs(), getOrder(), getOrientation(),
  118.      getPageBorder(), getPageBorderX(), getPageBorderY(), getPageBorderZ(),
  119.      getPageCounts(), getPageDelta(), getPageDimensions(), getPageIndices(),
  120.      getPageOrigin(), getPageOriginC(), getPageOriginX(), getPageOriginY(),
  121.      getPageOriginZ(), getPageSize(), getPageSizeC(), getPageSizePix(),
  122.      getPageSizeVal(), getPageSizeX(), getPageSizeY(), getPageSizeZ(),
  123.      getPixel(), getPixel3D(), getPriority(), getScaleMax(), getScaleMin(),
  124.      getSize(), getStrides(), getSubTile(), getSubTile3D(), getTile(),
  125.      getTile3D(), getWidth(), getXsize(), getYsize(), getZsize(),
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg((((3333))))      IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll      iiiillllMMMMeeeerrrrggggeeeeIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.      hasPageBorder(), hasPages(), hwDefine(), hwGetPass(), inherit(),
  141.      initColorModel(), initHwEnable(), initMinMax(), initPageSize(),
  142.      initScaleMinMax(), isColorImg(), isIntegral(), isMirrorOrientation(),
  143.      isPartialPage(), isSigned(), isValidPage(), isWritable(), lockPage(),
  144.      lockPageSet(), lockTile(), lockTile3D(), mapFlipTrans(), mapFromInput(),
  145.      mapFromSource(), mapOrientation(), mapSize(), mapTile(), mapToInput(),
  146.      mapToSource(), mapXY(), mapXYSign(), outOfBound(), qCopyTileCfg(),
  147.      qFillTile3D(), qFillTileRGB(), qGetSubTile3D(), qGetTile3D(),
  148.      qLockPageSet(), qSetSubTile3D(), qSetTile3D(), removeHwHint(),
  149.      removeInput(), reset(), setColorModel(), setColormap(), setCompression(),
  150.      setCsize(), setDataType(), setDisplayCacheEnable(), setFill(),
  151.      setFillValue(), setHwEnable(), setHwHint(), setHwIntHint(), setInput(),
  152.      setMaxColormapLevels(), setMaxValue(), setMinValue(), setNumChans(),
  153.      setNumInputs(), setOrder(), setOrientation(), setPageBorder(),
  154.      setPageSize(), setPageSizeC(), setPageSizeZ(), setPixel(), setPixel3D(),
  155.      setPriority(), setScaleMinMax(), setScaleType(), setSize(), setSubTile(),
  156.      setSubTile3D(), setTile(), setTile3D(), setTileRequirementFunction(),
  157.      setWritable(), setXsize(), setYsize(), setZsize(), unlockPage(),
  158.      unlockPageSet()
  159.  
  160.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  161.      addResetCallback(), alterAction(), anyAltered(), clearAllowed(),
  162.      clearSet(), clearStatus(), deleteRelated(), disableAltered(),
  163.      dumpChain(), getClassPropSet(), getDescription(), getDirectParent(),
  164.      getDisabledIndex(), getFloatProp(), getGenerationID(), getIntProp(),
  165.      getMaxIndex(), getMinIndex(), getNumChildren(), getNumParents(),
  166.      getParent(), getProp(), getProp(), getPropSet(), getPtrProp(),
  167.      getRelatedChild(), getRelatedDelete(), getRelatedType(), getStatus(),
  168.      hasResetCallbacks(), ilGetClassPropSet(), inProgress(), isAllowed(),
  169.      isAltered(), isEnabled(), isRelated(), isSet(), markSet(), mpUnlock(),
  170.      neverReset(), newRelatedType(), removeParent(), removeProp(),
  171.      removeResetCallback(), reset(), resetAltered(), resetCheck(),
  172.      setAllowed(), setAltered(), setDescription(), setDisabledIndex(),
  173.      setEnabled(), setParent(), setProp(), setPropAltered(),
  174.      setRelatedDelete(), setRelatedType(), setStatus(), stopWatching(),
  175.      unalterable(), watch(), watchNotify()
  176.  
  177. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  178.      ilLink(3), ilImage(3), ilCacheImg(3), ilMemCacheImg(3), ilOpImg(3)
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.